gnss22 2.2.0
Loading...
Searching...
No Matches
gnss22.h File Reference

This file contains API for GNSS 22 Click Driver. More...

#include "drv_digital_out.h"
#include "drv_digital_in.h"
#include "drv_i2c_master.h"
#include "drv_uart.h"

Go to the source code of this file.

Data Structures

struct  gnss22_t
 GNSS 22 Click context object. More...
struct  gnss22_cfg_t
 GNSS 22 Click configuration object. More...

Macros

#define GNSS22_RSP_START   "$"
 GNSS 22 response buffer commands.
#define GNSS22_RSP_DELIMITER   ","
#define GNSS22_RSP_END   "\r\n"
#define GNSS22_RSP_GGA   "GGA"
#define GNSS22_DUMMY   0xFF
 GNSS 22 dummy data.
#define GNSS22_IDLE_DATA   0x0A
#define GNSS22_GGA_ELEMENT_SIZE   15
 GNSS 22 GGA command elements.
#define GNSS22_GGA_TIME   1
#define GNSS22_GGA_LATITUDE   2
#define GNSS22_GGA_LATITUDE_SIDE   3
#define GNSS22_GGA_LONGITUDE   4
#define GNSS22_GGA_LONGITUDE_SIDE   5
#define GNSS22_GGA_QUALITY_INDICATOR   6
#define GNSS22_GGA_NUMBER_OF_SATELLITES   7
#define GNSS22_GGA_H_DILUTION_OF_POS   8
#define GNSS22_GGA_ALTITUDE   9
#define GNSS22_GGA_ALTITUDE_UNIT   10
#define GNSS22_GGA_GEOIDAL_SEPARATION   11
#define GNSS22_GGA_GEOIDAL_SEPARATION_UNIT   12
#define GNSS22_GGA_TIME_SINCE_LAST_DGPS   13
#define GNSS22_GGA_DGPS_REFERENCE_STATION_ID   14
#define GNSS22_TX_DRV_BUFFER_SIZE   100
 GNSS 22 driver buffer size.
#define GNSS22_RX_DRV_BUFFER_SIZE   800
#define GNSS22_DEVICE_ADDRESS   0x10
 GNSS 22 device address setting.
#define GNSS22_MAP_MIKROBUS(cfg, mikrobus)
 MikroBUS pin mapping.

Typedefs

typedef err_t(* gnss22_master_io_t) (struct gnss22_s *, uint8_t *, uint16_t)

Enumerations

enum  gnss22_drv_t { GNSS22_DRV_SEL_UART , GNSS22_DRV_SEL_I2C }
 GNSS 22 Click driver selector. More...
enum  gnss22_return_value_t { GNSS22_OK = 0 , GNSS22_ERROR = -1 }
 GNSS 22 Click return value data. More...

Functions

void gnss22_cfg_setup (gnss22_cfg_t *cfg)
 GNSS 22 configuration object setup function.
void gnss22_drv_interface_sel (gnss22_cfg_t *cfg, gnss22_drv_t drv_sel)
 GNSS 22 driver interface setup function.
err_t gnss22_init (gnss22_t *ctx, gnss22_cfg_t *cfg)
 GNSS 22 initialization function.
err_t gnss22_generic_write (gnss22_t *ctx, uint8_t *data_in, uint16_t len)
 GNSS 22 data writing function.
err_t gnss22_generic_read (gnss22_t *ctx, uint8_t *data_out, uint16_t len)
 GNSS 22 data reading function.
uint8_t gnss22_get_pps_pin (gnss22_t *ctx)
 GNSS 22 get PPS pin function.
uint8_t gnss22_get_fix_pin (gnss22_t *ctx)
 GNSS 22 get FIX pin function.
void gnss22_set_rst_pin (gnss22_t *ctx, uint8_t state)
 GNSS 22 set RST pin function.
void gnss22_set_stb_pin (gnss22_t *ctx, uint8_t state)
 GNSS 22 set STB pin function.
void gnss22_set_fon_pin (gnss22_t *ctx, uint8_t state)
 GNSS 22 set FON pin function.
void gnss22_reset_device (gnss22_t *ctx)
 GNSS 22 reset device function.
err_t gnss22_parse_gga (uint8_t *rsp_buf, uint8_t gga_element, uint8_t *element_data)
 GNSS 22 parse GGA function.

Detailed Description

This file contains API for GNSS 22 Click Driver.

Typedef Documentation

◆ gnss22_master_io_t

typedef err_t(* gnss22_master_io_t) (struct gnss22_s *, uint8_t *, uint16_t)

Driver serial interface.

Enumeration Type Documentation

◆ gnss22_drv_t

GNSS 22 Click driver selector.

Selects target driver interface of GNSS 22 Click driver.

Enumerator
GNSS22_DRV_SEL_UART 

UART driver descriptor.

GNSS22_DRV_SEL_I2C 

I2C driver descriptor.

◆ gnss22_return_value_t

GNSS 22 Click return value data.

Predefined enum values for driver return values.

Enumerator
GNSS22_OK 
GNSS22_ERROR